home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / filereqclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.4 KB  |  111 lines
  1. TABLE OF CONTENTS
  2.  
  3. filereqclass/--background--
  4. filereqclass/FILEREQ_Drawer
  5. filereqclass/FILEREQ_File
  6. filereqclass/FILEREQ_MultiHook
  7. filereqclass/FILEREQ_Path
  8. filereqclass/FILEREQ_Pattern
  9.  
  10. filereqclass/--background--
  11.  
  12.     NAME
  13.     Class:        filereqclass
  14.     Superclass:    aslreqclass
  15.     Include File:    <libraries/bgui.h>
  16.  
  17.     FUNCTION
  18.     To  provide  a    BOOPSI    interface  class to the ASL FileRequester. The
  19.     advantage  of  this  class is that the objects remember their complete
  20.     settings  like    requester  size,  path,  directory,  file  and pattern
  21.     strings as long as the object remains valid.
  22.  
  23.     NOTE
  24.     All  the  ASL filerequester attributes as defined in <libraries/asl.h>
  25.     are  usable  with this class. Applicability  for  these ASL attributes
  26.     is (ISGU).
  27.  
  28.     SEE ALSO
  29.     <libraries/asl.h>, aslreqclass.doc
  30.  
  31. filereqclass/FILEREQ_Drawer
  32.  
  33.     NAME
  34.     FILEREQ_Drawer -- ( STRPTR )
  35.  
  36.     FUNCTION
  37.     To obtain a pointer to the directory name of the filerequester.
  38.     When set, this tag is equivalent to ASLFR_InitialDrawer.
  39.  
  40.     APPLICABILITY
  41.     (ISG).
  42.  
  43.     SEE ALSO
  44.     FILEREQ_File, FILEREQ_Pattern, FILEREQ_Path
  45.  
  46. filereqclass/FILEREQ_File
  47.  
  48.     NAME
  49.     FILEREQ_File -- ( STRPTR )
  50.  
  51.     FUNCTION
  52.     To obtain a pointer to the file name of the filerequester.
  53.     When set, this tag is equivalent to ASLFR_InitialFile.
  54.  
  55.     APPLICABILITY
  56.     (ISG).
  57.  
  58.     SEE ALSO
  59.     FILEREQ_Drawer, FILEREQ_Pattern, FILEREQ_Path
  60.  
  61. filereqclass/FILEREQ_MultiHook
  62.  
  63.     NAME
  64.     FILEREQ_MultiHook -- ( struct Hook * ) ** V40 **
  65.  
  66.     FUNCTION
  67.     To install a callback hook for multi-select filerequesters.  The  hook
  68.     is called with a pointer to the ASL  FileRequester  structure  as  the
  69.     message packet in register A1.
  70.  
  71.     You may not cache this pointer. Copy the data you need.
  72.  
  73.     There is no return code specified for the callback hook.
  74.  
  75.     DEFAULT
  76.     NULL.
  77.  
  78.     APPLICABILITY
  79.     (ISG).
  80.  
  81. filereqclass/FILEREQ_Path
  82.  
  83.     NAME
  84.     FILEREQ_Path -- ( STRPTR )
  85.  
  86.     FUNCTION
  87.     To  obtain  a  pointer    to the full path of the filerequester. This is
  88.     simply the directory with the file name AddPart()'d to it.
  89.  
  90.     APPLICABILITY
  91.     (G)
  92.  
  93.     SEE ALSO
  94.     FILEREQ_Drawer, FILEREQ_File, FILEREQ_Pattern, dos.library/AddPart()
  95.  
  96. filereqclass/FILEREQ_Pattern
  97.  
  98.     NAME
  99.     FILEREQ_Pattern -- ( STRPTR )
  100.  
  101.     FUNCTION
  102.     To obtain a pointer to the pattern string of the filerequester.
  103.     When set, this tag is equivalent to ASLFR_InitialPattern.
  104.  
  105.     APPLICABILITY
  106.     (ISG).
  107.  
  108.     SEE ALSO
  109.     FILEREQ_Drawer, FILEREQ_File, FILEREQ_Path
  110.  
  111.